--- id: Banking - DDA-spec title: "Ficha técnica" handle: Débito Direto Autorizado description: "" custom_edit_url: null --- ## Escopos necessários O token para consumir a API Débito Direto Autorizado (DDA) deve ser gerado usando o Authorization Code. O escopo `openid`é obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta. | Escopo | Descrição | | :-------------------------------------- | :-------------------------- | | `brn:btg:empresas:banking:direct-debit` | Permite operar a API de DDA | ## Dicionário de Termos | Termos | Descrição | | :-------- | :------------------------------------------------- | | companyId | CNPJ da empresa cujos DDAs estão sendo consultados | ## Eventos de webhook Os payloads disponíveis abaixo representam o conteúdo do campo `data`. | Evento | Descrição | | :------------------------------------- | :---------------- | | `authorized-direct-debits.enabled` | DDA Habilitado | | `authorized-direct-debits.disabled` | DDA Desabilitado | | `authorized-direct-debits.debit-paid` | Débito pago | | `authorized-direct-debits.debit-added` | Débito adicionado | ### authorized-direct-debits.enabled ```json { "accountId": "37297902000141-208-50-003886850", "date": "2022-03-02T22:01:55.274Z", "creditDebitIndicator": "DEBIT", "amount": 30900, "currency": "BRL", "transactionId": "33449743" } ``` ### authorized-direct-debits.disabled ```json { "directDebitId": "00000000-8bcf-488b-85f9-8b3a041e3eef", "owner": { "taxId": "30306294000145", "name": "NOME EMPRESA" }, "status": "DISABLED" } ``` ### authorized-direct-debits.debit-added ```json { "directDebitId": "00000000-7779-4f25-bec0-ebb3391589be", "owner": { "taxId": "30306294000145", "name": "NOME EMPRESA" }, "status": "ENABLED", "debits": [ { "id": "00000000-0000-0000-0000-c35ba9199d96", "amount": 24193.61, "dueDate": "2023-03-16", "expirationDate": "2024-03-16", "digitableLine": "20800000000000000000000000000000000000000004800", "status": "CREATED", "payee": { "taxId": "30306294000145", "socialName": "Emiss_o Boleto BTG", "fantasyName": "Emiss_o Boleto BTG", "bank": { "code": "208", "name": "BANCO BTG PACTUAL S.A." } } }, { "id": "00000000-0000-0000-0000-c35ba9199d97", "amount": 24193.61, "dueDate": "2023-03-16", "expirationDate": "2024-03-16", "digitableLine": "20800000000000000000000000000000000000000004800", "status": "CREATED", "payee": { "taxId": "30306294000145", "socialName": "Emiss_o Boleto BTG", "fantasyName": "Emiss_o Boleto BTG", "bank": { "code": "208", "name": "BANCO BTG PACTUAL S.A." } } } ] } ``` ### authorized-direct-debits.debit-paid ```json { "directDebitId": "00000000-0000-0000-0000-ebb3391589be", "owner": { "taxId": "00000000000001", "name": "NOME EMPRESA" }, "status": "ENABLED", "debits": [ { "id": "00000000-0000-0000-0000-c35ba9199d97", "amount": 4948.1, "dueDate": "0001-01-01", "expirationDate": "0001-01-01", "digitableLine": "20800000000000000000000000000000000000000004800", "status": "PAID", "payee": { "taxId": "00000000000001", "socialName": "SOCIAL NAME", "fantasyName": "NAME", "bank": { "code": "208", "name": "BANCO BTG PACTUAL S.A." } } } ] } ```